예시

Grouping Tasks

Multiple task

Default Task

Abbreviated Task

Command line options

Defining tasks

Locating tasks

Task dependencies, ordering

Task input, output

Grouping Tasks

직접 커스텀 task를 정의해본 뒤 ./gradlew tasks를 실행해보면 정의한 task가 표시되지 않음

task의 group을 지정해야 볼 수 있는데, 지정되지 않은 모든 task를 보려면 ./gradlew tasks --all 수행

task 그룹 지정

// build.gradle.kts
tasks.register<Copy>("testCopy") {
    group = "custom task"
    ...
}

기본 제공되는 task와 plugin으로 인해 추가된 task는 미리 그룹화되어 있음

group 확인 방법

• ./gradlew tasks
• intelliJ 사용 시 gradle 툴 바를 보면 Tasks가 그룹 확인 가능

Multiple task

gradle은 0개, 1개, 여러 개의 task를 수행할 수 있음

한 개의 task 수행 : ./gradlew task1

여러 개 task 수행 : ./gradlew task1 task2

Default Task

기본 수행 task : help

// build.gradle.kts
defaultTasks("someTask")

Abbreviated Task

task 이름을 축약해서 사용 가능(custom task도 가능)

• ./gradlew h : ./gradlew help

카멜 케이스로 단어 구분

• ./gradlew hW : ./gradlew helloWorld

약칭 충돌 시 gradle이 설명해줌 - 구분 지어질 정도로 약칭 사용하면 됨

• ./gradlew h : ./gradlew help, ./gradlew helloWorld 충돌
• ./gradlew hW 또는 ./gradlew hello

Command line options

task 별 옵션 정리

주요 옵션

• ./gradlew -h, --help : 도움말
• ./gradlew specificTask --info : 특정 task에 대한 상세 정보
• ./gradlew specificTask --console=verbose : gradle output text 포맷 지정
  • console 옵션 값 : auto(default), plain, rich, verbose

Defining Task

Defining : task type, 로직 정의

task class

• task가 수행해야 될 실제 로직이 담겨있는 task 클래스
• Gradle 소스코드나 플러그인에 미리 정의되어 있는 task 클래스를 “built”라고 일컬음

task definition

• task 클래스의 인스턴스를 정의하는 과정(인스턴스 이름 지정)
• 정의할 task가 무슨 동작을 할지 구성함

task는 크게 두 가지로 나뉨

• class-based task : task class 기반 task definition
  • task가 제공하는 프로퍼티를 사용하여 task 동작 구성
• ad-hoc task : 커스텀 task class 기반 task definition

task 정의 방법

방법 1 : tasks.register

• tasks.register()
• build 시 실제로 사용할 task들만 생성 및 구성됨

tasks.register<Copy>("generateApiDocs") {
}

• tasks.registering() - 변수 할당

val generateApiDocs by tasks.registering(Copy::class)

두 방법 모두 class-based task 또는 ad-hoc task을 정의할 수 있음

// class-based
tasks.register<Copy>("generatedApiDocs") {
    from(...)
    into(...)
}

// ad-hoc
tasks.register("greeting") {
  doLast {
    println("Hello World")
  }
}

방법 2 : task()

원래 사용하던 방법으로 지금은 tasks.register()로 대체됨

task<Copy>("generateApiDocs")

task 정의 프로퍼티

task를 정의할 때 람다식을 사용하여 함수 또는 프로퍼티 셋을 전달함

람다에 사용하는 프로퍼티들은 정의하고 있는 task 타입에 의존함 - i.g) copy 타입의 task 정의시 from(), into() 사용

공통 프로퍼티

• group
• description
• doFirst (lambda)
• doLast (lambda)
• enabled
• onlyIf

doFirst, doLast

task 실행 전, 실행 후 전달받은 람다 실행

tasks.register<Copy>("generateApiDocs") {
    doFirst {
        println("before generate api docs")
    }
  
    doLast {
        println("after generate api docs")
    }
}

enabled

task 실행 여부를 결정할 수 있음

기본 값 true

tasks.register<Copy>("coding") {
    enabled = false
}

onlyIf

특정 조건이 참일 때 task 실행

tasks.register<Copy>("coding") {
    onlyIf {
        // condition
    }
}

Locating Tasks

Locating : task reference를 가져온 뒤, 로직을 수정하는 방법

방법 1 : tasks.named

tasks.named<Copy>("generateApiDocs") { 
    doFirst { 
        println("doFirst modified by tasks.named locating") 
    }
}

// tasks.named method definition
TaskProvider<T> named(String name)

TaskProvider<T> named(String name, Action<? super T> configurationAction)

권장 방법

task를 생성, 구성하지 않으면서 참조를 할 수 있는 방법

named()는 TaskProvider를 반환함

TaskProvider는 task를 생성하지 않으면서 task에 대한 참조를 가져올 수 있음

방법 2 : tasks.getByName

tasks.getByName<Copy>("generateApiDocs").configure { 
    doFirst { 
        println("doFirst modified by tasks.getByName locating") 
    }
}

// tasks.getByName method definition
T getByName(String name)

T getByName(String name, Closure configureClosure)

권장되지 않는 방법

Task 자체를 반환함 -> task 생성 및 구성이 불가피해짐

**방법 3 : tasks.**

tasks.clean {
      doLast {
          println("doFirst modified by tasks.<taskName> locating")
      }
}

기본 task(help, clean 등)에 대해 적용할 수 있는 방법

named()와 마찬가지로 TaskProvider를 반환함 -> configuration avoidance

Task dependencies, ordering

task간 의존성을 설정하여 task 실행 순서를 결정

각 task의 의존성은 producer-consumer 관계로 설정됨

producer : 먼저 실행되야 할 task, consumer task에 입력 값을 제공

consumer : producer task 이후에 실행되어야 하거나 출력 값을 사용하는 task

producer task <---- depends on ----- consumer task

dependsOn

다른 task에 대한 의존성을 명시하는 방법

task를 변수에 할당해서 일관적인 참조를 유지할 수 있음

val producer = tasks.register("producer") {
  doLast {
    println("producer task")
  }
}

tasks.register("consumer") {
  dependsOn(producer)
  doLast {
    println("consumer task")
  }
}

mustRunAfter

특정 task는 명시한 task 후에 실행되어야 할 때 사용

val producer = tasks.register("producer") {
  ...
}

tasks.register("consumer") {
  mustRunAfter(producer)
  ...
}

finalizedBy

특정 task가 실행된 후 무조건 실행되어야 하는 task 명시할 때 사용

try-catch-finally와 유사하게 특정 task가 실패되더라도 명시한 task는 무조건 실행됨

tasks.register("producer") {
  ...
  finalizedBy(consumer)
}

val consumer = tasks.register("consumer") {

  ...
}

Task input, output

task는 입력을 받아 action을 수행한 뒤 출력을 반환함

task가 입출력을 가지는 것이 의무는 아니지만 없을 경우 incremental build 기능을 사용할 수 없음

inputs ----> task action ----> outputs

gradle task의 입출력이 있다는 사실로 유용한 기능을 제공함

Incremental build

task를 실행했을 때 gradle은 이전의 실행 이후 변경된 입출력이 없다면 task를 실행하지 않고 “up-to-date”로 표시함

-> 빌드 실행 시간 단축

Link task inputs & outputs

다른 task의 출력을 입력값으로 사용해야 될 경우 dependsOn() 대신 task에 대한 참조를 입력값으로 직접 설정할 수 있음

아래처럼 task 참조를 입력값으로 사용할 경우 gradle이 의존성을 자동으로 설정함 -> implicit dependencies

dependsOn 명시 생략 가능

val producer = tasks.register("producer") {
  ...
}

tasks.register<Copy>("consumer") {
  from(producer)
  into(layout.buildDirectory.dir("consumer"))
}